vcFocusModeManager

Represents container for focus mode objects that is used to start Focus Mode feature. Content of the focus set will be kept focused, everything that is not included in the set will become unfocused when focus mode is started.

See in: Overview

Module: vcCore

Parent: vcObject

Children -

Referenced by: vcWorld.FocusModeManager

Properties

Learn how to use properties here. The properties are also inherited from the parent class.

Name	Type	Access	Description
DynamicComponentFocusSetting	vcFocusModeDynamicSetting	RW	Gets or sets how to display dynamic components during simulation while focus mode is active.
FocusSets	list	R	Gets the focus sets that this manager contains.
IsFocusModeActive	Boolean	R	Gets a value indicating whether focus mode is currently active or not.
UnfocusedOpacity	Real	RW	Gets or sets opacity value for the unfocused objects. See more Value can be between 0 and 1 where 0 meaning that objects are not visible and 1 no transparency at all.

Methods

Learn how to use methods here. The methods are also inherited from the parent class.

Name	Return Type	Parameters	Description
createFocusSet	vcFocusSet	List[vcNode] nodeList	Creates a new instance of vcFocusSet with given vcNodes. And adds its to the current vcFocusModeManagerInstance. See more Raises event ObjectSetAdded in case of success. Parameters: nodeList (List[vcNode]): Nodes to be used for the vcFocusSet creation. Will only include supported node types. Returns: vcFocusSet: Created set or None in case creation failed.
removeFocusSet	Boolean	vcFocusSet focusSet	Removes given vcFocusSet from current FocusModeManager instance. See more Raises event ObjectSetRemoved in case of success. Parameters: focusSet (vcFocusSet): Set to be removed. Returns: bool: True if was removed, False otherwise.
startFocusMode	None	List[vcFocusSet] focusSets	Starts focus mode for the given list of vcFocusSet. See more Raises event FocusModeStarted in case of success. Parameters: focusSets (List[vcFocusSet]): Focus sets to use for focusing.
stopFocusMode	None	None	Stops focus mode. Raises event FocusModeStopped in case of success.

Events

Learn how to use events here. The events are also inherited from the parent class.

Name	Parameters	Description
FocusModeStarted	None	Triggered when Focus Mode started.
FocusModeStopped	None	Triggered when Focus Mode stopped.
FocusSetAdded	None	Triggered when new vcFocusSet added to vcFocusModeManager.
FocusSetRemoved	None	Triggered when vcFocusSet removed from vcFocusModeManager.